oracle.AWXML
Class OlapMeasure

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.Measure
              |
              +--oracle.AWXML.OlapMeasure

public class OlapMeasure

extends Measure

A Measure that has values that result from certain OLAP operations, such as a lead, lag, or moving average operation. The operations are time series calculations that are based on values of another Measure, which is the referenced Measure for the operation.

The values of the referenced Measure are specified by the members of a time Dimension. Some operations involve members of Hierarchy or Level. Some operations use scalar or other values to identify values of the referenced Measure that are involved in the calculation.

An OlapMeasure has an OLAP operator that determines the type of OLAP operation. You specify the OLAP operator with the setOlapOperator method. The default value of the OLAP operator is LEAD. The Measure and other objects that the operation references and the values that it uses are specified by OlapMeasureInput objects.

The following list has the OLAP operations that produce the values of an OlapMeasure. For descriptions of the operations, and for a table of the OLAP operator values and the OlapMeasureInput keywords, objects, and values required by the operations, see OlapMeasure OLAP Operator Values and OlapMeasureInput Keywords and Objects or Values. To see the OLAP operator value and the OlapMeasureInput referenced objects and values required for a specific operation, select an item from the list.

Cumulative total parent Cumulative total total Lag Lead Moving average Moving maximum Moving minimum Moving total

Future period Period to date Prior period Prior period variance Prior period variance percentage Same period ancestors ago Same period ancestors ago variance Same period ancestors ago variance percent Same period ancestors fvd Year to date

Rank level Rank parent Rank total Share to level Share to parent Share to total

An OlapMeasure is owned by a Cube. To create an OlapMeasure, use the createOlapMeasure method of a Cube.

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

OlapMeasure(BaseObject input)
Creates an OlapMeasure for the specified Cube.

Method Summary

void	addOlapMeasureInput(OlapMeasureInput input) Adds the specified OlapMeasureInput to the list of OlapMeasureInput objects of the OlapMeasure.
java.lang.String	Alter(AWConnection connection) Alters the OlapMeasure in the current analytic workspace of the specified database connection.
java.lang.String	Create(AWConnection connection) Creates an OlapMeasure in the current analytic workspace of the specified database connection.
OlapMeasureInput	createOlapMeasureInput() Creates an OlapMeasureInput and adds it to the list of OlapMeasureInput objects of the OlapMeasure.
java.lang.String	Delete(AWConnection connection) Deletes the OlapMeasure in the current analytic workspace of the specified database connection.
java.util.Vector	getOlapMeasureInputs() Gets the list of OlapMeasureInput objects of the OlapMeasure.
java.lang.String	getOlapOperator() Gets the operation specified for the OlapMeasure.
boolean	isValid() Indicates whether the OlapMeasure is a valid object in the analytic workspace.
void	removeOlapMeasureInput(OlapMeasureInput input) Removes the specified OlapMeasureInput from the list of OlapMeasureInput objects of the OlapMeasure.
void	setOlapOperator(java.lang.String input) Specifies the OLAP operation for the OlapMeasure.
java.lang.String	WriteToXML() Gets an XML representation of the OlapMeasure.

Methods inherited from class oracle.AWXML.Measure

getAutoSolve, getDataType, getSolveDefinition, setAutoSolve, setDataType, setSolveDefinition

Methods inherited from class oracle.AWXML.BaseObject

CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OlapMeasure

public OlapMeasure(BaseObject input)

Creates an OlapMeasure for the specified Cube. An application should create an OlapMeasure by using the createOlapMeasure method of a Cube.

Parameters:

input - The Cube to own the OlapMeasure.

Method Detail

setOlapOperator

public void setOlapOperator(java.lang.String input)

Specifies the OLAP operation for the OlapMeasure. The valid values for the input parameter are the following.

   CUMLATIVE_TOTAL_TOTAL
   CUMULATIVE_TOTAL_PARENT
   LAG
   LEAD
   FUTURE_PERIOD
   MOVINGAVERAGE
   MOVINGMAX
   MOVINGMIN
   MOVINGTOTAL
   PERIOD_TO_DATE
   PRIOR_PERIOD
   PRIOR_PERIOD_VARIANCE
   PRIOR_PERIOD_VARIANCE_PERCENTAGE
   RANK_PARENT
   RANK_TOTAL
   SAME_PERIOD_ANCESTORS_AGO
   SAME_PERIOD_ANCESTORS_AGO_FVD
   SAME_PERIOD_ANCESTORS_AGO_VARIANCE
   SAME_PERIOD_ANCESTORS_AGO_VARIANCE_PERCENT
   SHARE_TO_LEVEL
   SHARE_TO_PARENT
   SHARE_TO_TOTAL
   YEAR_TO_DATE

For descriptions of these operations, see OlapMeasure OLAP Operator Values and OlapMeasureInput Keywords and Objects or Values.

Parameters:

input - A String that specifies an operation for the OlapMeasure.

getOlapOperator

public java.lang.String getOlapOperator()

Gets the operation specified for the OlapMeasure.

Returns:

A String that contains the operation specified for the OlapMeasure.

addOlapMeasureInput

public void addOlapMeasureInput(OlapMeasureInput input)

Adds the specified OlapMeasureInput to the list of OlapMeasureInput objects of the OlapMeasure.

Parameters:

input - The OlapMeasureInput to add.

removeOlapMeasureInput

public void removeOlapMeasureInput(OlapMeasureInput input)

Removes the specified OlapMeasureInput from the list of OlapMeasureInput objects of the OlapMeasure.

Parameters:

input - The OlapMeasureInput to remove.

getOlapMeasureInputs

public java.util.Vector getOlapMeasureInputs()

Gets the list of OlapMeasureInput objects of the OlapMeasure.

Returns:

A Vector containing the OlapMeasureInput objects of the OlapMeasure.

createOlapMeasureInput

public OlapMeasureInput createOlapMeasureInput()

Creates an OlapMeasureInput and adds it to the list of OlapMeasureInput objects of the OlapMeasure.

Returns:

The new OlapMeasureInput.

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the OlapMeasure.

Overrides:

WriteToXML in class Measure

Returns:

An XML String that represents the OlapMeasure.

Create

public java.lang.String Create(AWConnection connection)

Creates an OlapMeasure in the current analytic workspace of the specified database connection. To create an OlapMeasure, an application should use the createOlapMeasure method of a Cube.

Overrides:

Create in class Measure

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

A String that contains success if this method successfully creates the OlapMeasure.

Alter

public java.lang.String Alter(AWConnection connection)

Alters the OlapMeasure in the current analytic workspace of the specified database connection.

Overrides:

Alter in class Measure

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

A String that contains success if this method successfully alters the OlapMeasure.

isValid

public boolean isValid()

Indicates whether the OlapMeasure is a valid object in the analytic workspace.

Returns:

A boolean that is true if the OlapMeasure is valid or false if it is not valid.

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the OlapMeasure in the current analytic workspace of the specified database connection. If it cannot delete the OlapMeasure, then this method throws an AWException exception.

Overrides:

Delete in class Measure

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

A String that contains success if the method deletes the OlapMeasure.